velaif820.h File Reference

This file contains API for Vela IF820 Click Driver. More...

#include "drv_digital_out.h"
#include "drv_digital_in.h"
#include "drv_uart.h"

Go to the source code of this file.

Data Structures
struct	velaif820_rsp_evt_packet_t
	Vela IF820 Click response/event packet object. More...
struct	velaif820_t
	Vela IF820 Click context object. More...
struct	velaif820_cfg_t
	Vela IF820 Click configuration object. More...

Macros
#define	VELAIF820_PACKET_CMD_ACTION   "/"
	Vela IF820 commands begin.
#define	VELAIF820_PACKET_CMD_SET   "S"
#define	VELAIF820_PACKET_CMD_GET   "G"
#define	VELAIF820_PACKET_CMD_PROFILE   "."
#define	VELAIF820_PACKET_RESPONSE   "@R"
#define	VELAIF820_PACKET_EVENT   "@E"
#define	VELAIF820_PACKET_PARAM_DELIMITER   ","
#define	VELAIF820_PACKET_END   "\r\n"
#define	VELAIF820_CMD_SYS_PING   "PING"
	Vela IF820 action commands.
#define	VELAIF820_CMD_SYS_REBOOT   "RBT"
#define	VELAIF820_CMD_SYS_DUMP   "DUMP"
#define	VELAIF820_CMD_SYS_STORE_CONFIG   "SCFG"
#define	VELAIF820_CMD_SYS_FACTORY_RESET   "RFAC"
#define	VELAIF820_CMD_SYS_QUERY_FW_VERSION   "QFV"
#define	VELAIF820_CMD_SYS_QUERY_RANDOM_NUM   "QRND"
#define	VELAIF820_CMD_SYS_WRITE_USER_DATA   "WUD"
#define	VELAIF820_CMD_SYS_READ_USER_DATA   "RUD"
#define	VELAIF820_CMD_GAP_CONNECT   "C"
#define	VELAIF820_CMD_GAP_CANCEL_CONNECTION   "CX"
#define	VELAIF820_CMD_GAP_DISCONNECT   "DIS"
#define	VELAIF820_CMD_GAP_START_ADV   "A"
#define	VELAIF820_CMD_GAP_STOP_ADV   "AX"
#define	VELAIF820_CMD_GAP_START_SCAN   "S"
#define	VELAIF820_CMD_GAP_STOP_SCAN   "SX"
#define	VELAIF820_CMD_GAP_QUERY_PEER_ADDRESS   "QPA"
#define	VELAIF820_CMD_GAP_QUERY_RSSI   "QSS"
#define	VELAIF820_CMD_SMP_QUERY_BONDS   "QB"
#define	VELAIF820_CMD_SMP_DELETE_BOND   "BD"
#define	VELAIF820_CMD_SMP_PAIR   "P"
#define	VELAIF820_CMD_BT_QUERY_NAME   "BTQN"
#define	VELAIF820_CMD_BT_CONNECT   "BTC"
#define	VELAIF820_CMD_BT_CANCEL_CONNECTION   "BTCX"
#define	VELAIF820_CMD_BT_DISCONNECT   "BTDIS"
#define	VELAIF820_CMD_BT_QUERY_PEER_ADDRESS   "BTQPA"
#define	VELAIF820_CMD_BT_QUERY_RSSI   "BTQSS"
#define	VELAIF820_CMD_PROTOCOL_PARSE_MODE   "PPM"
	Vela IF820 set/get commands.
#define	VELAIF820_CMD_PROTOCOL_ECHO_MODE   "PEM"
#define	VELAIF820_CMD_SYS_BT_ADDRESS   "BA"
#define	VELAIF820_CMD_SYS_TX_POWER   "TXP"
#define	VELAIF820_CMD_SYS_TRANSPORT   "T"
#define	VELAIF820_CMD_GAP_DEVICE_NAME   "DN"
#define	VELAIF820_CMD_GAP_DEVICE_APPEARANCE   "DA"
#define	VELAIF820_CMD_GAP_ADV_DATA   "AD"
#define	VELAIF820_CMD_GAP_SR_DATA   "SRD"
#define	VELAIF820_CMD_GAP_ADV_PARAMS   "AP"
#define	VELAIF820_CMD_GAP_SCAN_PARAMS   "SP"
#define	VELAIF820_CMD_GAP_CONNECTION_PARAMS   "CP"
#define	VELAIF820_CMD_SMP_PIN_CODE   "BTPIN"
#define	VELAIF820_CMD_CYSPP_START   "CYSPPSTART"
	Vela IF820 profile commands.
#define	VELAIF820_CMD_CYSPP_SET_PARAMS   "CYSPPSP"
#define	VELAIF820_CMD_CYSPP_GET_PARAMS   "CYSPPGP"
#define	VELAIF820_CMD_CYSPP_SET_PACKETIZATION   "CYSPPSK"
#define	VELAIF820_CMD_CYSPP_GET_PACKETIZATION   "CYSPPGK"
#define	VELAIF820_CMD_SPP_SEND_CMD   "SPPS"
#define	VELAIF820_CMD_SPP_SET_CFG   "SPPSC"
#define	VELAIF820_CMD_SPP_GET_CFG   "SPPGC"
#define	VELAIF820_EVT_SYS_BOOT   "BOOT"
	Vela IF820 event commands.
#define	VELAIF820_EVT_SYS_ERROR   "ERR"
#define	VELAIF820_EVT_SYS_FACTORY_RESET_COMPLETE   "RFAC"
#define	VELAIF820_EVT_SYS_DUMP_BLOB   "DBLOB"
#define	VELAIF820_EVT_GAP_ADV_STATE_CHANGED   "ASC"
#define	VELAIF820_EVT_GAP_SCAN_STATE_CHANGED   "SSC"
#define	VELAIF820_EVT_GAP_SCAN_RESULT   "S"
#define	VELAIF820_EVT_GAP_CONNECTED   "C"
#define	VELAIF820_EVT_GAP_DISCONNECTED   "DIS"
#define	VELAIF820_EVT_GAP_CONNECTION_UPDATED   "CU"
#define	VELAIF820_EVT_SMP_BOND_ENTRY   "B"
#define	VELAIF820_EVT_SMP_PAIRING_REQUESTED   "P"
#define	VELAIF820_EVT_SMP_PAIRING_RESULT   "PR"
#define	VELAIF820_EVT_SMP_ENCRYPTION_STATUS   "ENC"
#define	VELAIF820_EVT_SMP_PIN_ENTRY_REQUESTED   "BTPIN"
#define	VELAIF820_EVT_BT_INQUIRY_RESULT   "BTIR"
#define	VELAIF820_EVT_BT_NAME_RESULT   "BTINR"
#define	VELAIF820_EVT_BT_INQUIRY_COMPLETED   "BTIC"
#define	VELAIF820_EVT_BT_CONNECTED   "BTCON"
#define	VELAIF820_EVT_BT_CONNECTION_STATUS   "BTCS"
#define	VELAIF820_EVT_BT_CONNECTION_FAILED   "BTCF"
#define	VELAIF820_EVT_BT_DISCONNECTED   "BTDIS"
#define	VELAIF820_EVT_SPP_DATA_RECEIVED   "SPPD"
#define	VELAIF820_PACKET_TYPE_EVENT   0
	Vela IF820 response and event flag settings.
#define	VELAIF820_PACKET_TYPE_RESPONSE   1
#define	VELAIF820_RSP_TIMEOUT_1000MS   1000
	Vela IF820 timeout settings.
#define	VELAIF820_CMD_TIMEOUT_5000MS   5000
#define	VELAIF820_WAIT_TIMEOUT_5S   5
#define	VELAIF820_WAIT_TIMEOUT_INFINITE   0
#define	VELAIF820_CMD_CODE_BUFFER_SIZE   20
	Vela IF820 driver buffer size.
#define	VELAIF820_PAYLOAD_BUFFER_SIZE   200
#define	VELAIF820_TX_DRV_BUFFER_SIZE   200
#define	VELAIF820_RX_DRV_BUFFER_SIZE   500
#define	VELAIF820_MAP_MIKROBUS(cfg, mikrobus)
	MikroBUS pin mapping.

Enumerations
enum	velaif820_return_value_t { VELAIF820_OK = 0 , VELAIF820_ERROR = -1 , VELAIF820_ERROR_TIMEOUT = -2 , VELAIF820_ERROR_CMD = -3 }
	Vela IF820 Click return value data. More...

Functions
void	velaif820_cfg_setup (velaif820_cfg_t *cfg)
	Vela IF820 configuration object setup function.
err_t	velaif820_init (velaif820_t *ctx, velaif820_cfg_t *cfg)
	Vela IF820 initialization function.
err_t	velaif820_generic_write (velaif820_t *ctx, uint8_t *data_in, uint16_t len)
	Vela IF820 data writing function.
err_t	velaif820_generic_read (velaif820_t *ctx, uint8_t *data_out, uint16_t len)
	Vela IF820 data reading function.
void	velaif820_set_rst_pin (velaif820_t *ctx, uint8_t state)
	Vela IF820 set RST pin function.
void	velaif820_reset_device (velaif820_t *ctx)
	Vela IF820 reset device function.
void	velaif820_set_rts_pin (velaif820_t *ctx, uint8_t state)
	Vela IF820 set RTS pin function.
uint8_t	velaif820_get_cts_pin (velaif820_t *ctx)
	Vela IF820 get CTS pin function.
uint8_t	velaif820_get_hwe_pin (velaif820_t *ctx)
	Vela IF820 get HWE pin function.
void	velaif820_set_cmd_mode (velaif820_t *ctx)
	Vela IF820 set cmd mode function.
void	velaif820_set_data_mode (velaif820_t *ctx)
	Vela IF820 set data mode function.
void	velaif820_cmd_action (velaif820_t *ctx, uint8_t *cmd, uint8_t *params)
	Vela IF820 cmd action function.
void	velaif820_cmd_set (velaif820_t *ctx, uint8_t *cmd, uint8_t *params)
	Vela IF820 cmd set function.
void	velaif820_cmd_get (velaif820_t *ctx, uint8_t *cmd, uint8_t *params)
	Vela IF820 cmd get function.
void	velaif820_cmd_profile (velaif820_t *ctx, uint8_t *cmd, uint8_t *params)
	Vela IF820 cmd profile function.
err_t	velaif820_read_packet (velaif820_t *ctx)
	Vela IF820 read packet function.

Detailed Description

This file contains API for Vela IF820 Click Driver.

Enumeration Type Documentation

velaif820_return_value_t

enum velaif820_return_value_t

Vela IF820 Click return value data.

Predefined enum values for driver return values.

Enumerator
VELAIF820_OK
VELAIF820_ERROR
VELAIF820_ERROR_TIMEOUT
VELAIF820_ERROR_CMD